API Documentation
MainSystem.h
1 // MainSystem.h
3 //
5 
6 namespace nkGraphics
7 {
13  class MainSystem final : public nkCommon::SingletonClass<nkGraphics::MainSystem>
14  {
15  public :
16 
21 
22  // Getters
26  Renderer* getRenderer () const ;
30  bool isInitialized () const ;
34  bool getHasRunToContinue () const ;
35 
36  // Setters
42  void setHasRunToContinue (bool value) ;
43 
44  // To start
51  bool autoConfigure () ;
58  bool initialize () ;
66  void run (RenderContext* context) ;
67 
68  // To end
72  void shutdown () ;
73 
74  // Step by step
81  bool frame (RenderContext* context) ;
88  void tickForNewFrame (RenderContext* context) ;
89  } ;
90 }
nkGraphics::MainSystem::isInitialized
bool isInitialized() const
nkGraphics::MainSystem
Main interface with the component system.
Definition: MainSystem.h:14
nkGraphics::MainSystem::getHasRunToContinue
bool getHasRunToContinue() const
nkGraphics::MainSystem::~MainSystem
~MainSystem()
nkGraphics::MainSystem::getRenderer
Renderer * getRenderer() const
nkGraphics::MainSystem::tickForNewFrame
void tickForNewFrame(RenderContext *context)
nkGraphics::RenderContext
A rendering context, attached to a graphic window to present to the screen.
Definition: RenderContext.h:12
nkGraphics::MainSystem::frame
bool frame(RenderContext *context)
nkGraphics::Renderer
A renderer, implementing the logic of using a graphics API.
Definition: Renderer.h:18
nkGraphics::MainSystem::shutdown
void shutdown()
nkGraphics::MainSystem::run
void run(RenderContext *context)
nkGraphics::MainSystem::setHasRunToContinue
void setHasRunToContinue(bool value)
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::MainSystem::autoConfigure
bool autoConfigure()
nkGraphics::MainSystem::initialize
bool initialize()